/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 - 2008 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/

package com.genia.toolbox.basics.bean;

import java.io.File;

import com.genia.toolbox.basics.exception.technical.TechnicalException;

/**
 * interface that represents an object than can retrieve an object from its xml
 * mapping.
 */
public interface Marshaller
{

  /**
   * Marshal the content tree rooted at <tt>jaxbElement</tt> into an output
   * stream.
   * 
   * @param object
   *          The root of content tree to be marshalled.
   * @param os
   *          XML will be added to this stream.
   * @throws TechnicalException
   *           If any unexpected problem occurs during the marshalling.
   */
  public void marshal(Object object, java.io.OutputStream os)
      throws TechnicalException;



  /**
   * Marshal the content tree rooted at <tt>jaxbElement</tt> into a file.
   * 
   * @param object
   *          The root of content tree to be marshalled.
   * @param output
   *          File to be written. If this file already exists, it will be
   *          overwritten.
   * @throws TechnicalException
   *           If any unexpected problem occurs during the marshalling.
   */
  public void marshal(Object object, File output)
      throws TechnicalException;



  /**
   * Marshal the content tree rooted at <tt>jaxbElement</tt> into a Writer.
   * 
   * @param object
   *          The root of content tree to be marshalled.
   * @param writer
   *          XML will be sent to this writer.
   * @throws TechnicalException
   *           If any unexpected problem occurs during the marshalling.
   */
  public void marshal(Object object, java.io.Writer writer)
      throws TechnicalException;

}
